actionobserver: Clarify primary_accel_changed docs
authorMatthias Clasen <mclasen@redhat.com>
Wed, 16 Jun 2021 14:34:37 +0000 (10:34 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Wed, 16 Jun 2021 14:34:37 +0000 (10:34 -0400)
Either action_name or action_and_target may be NULL
here, and observer implementations should be careful
when checking those values.

gtk/gtkactionobserver.c

index 77faa7fcb7d1507b1aaaa6e65a0d0c76dfc2ce18..96791a9a27f1990e114c2358821aebd8ff61daa9 100644 (file)
@@ -158,15 +158,17 @@ gtk_action_observer_action_removed (GtkActionObserver   *observer,
  * gtk_action_observer_primary_accel_changed:
  * @observer: a `GtkActionObserver`
  * @observable: the source of the event
- * @action_name: the name of the action
- * @action_and_target: detailed action of the changed accel, in “action and target” format
+ * @action_name: (nullable): the name of the action
+ * @action_and_target: (nullable): detailed action of the changed accel, in “action and target” format
  *
  * This function is called when an action that the observer is
  * registered to receive events for has one of its accelerators changed.
  *
  * Accelerator changes are reported for all targets associated with the
- * action.  The @action_and_target string should be used to check if the
+ * action. The @action_and_target string should be used to check if the
  * reported target is the one that the observer is interested in.
+ *
+ * Either @action_name or @action_and_target may be %NULL.
  */
 void
 gtk_action_observer_primary_accel_changed (GtkActionObserver   *observer,